package nci60.data.protein

/**
 * This domain class provides the to a protein assigned gene symbols derived from the HUGO Gene Nomenclature Committee (HGNC).
 *
 * @autor <a href="mailto:Florian.J.Auer@googlemail.com">Florian J. Auer</a>
*/
class GeneName {

    /**
    * Gene name (HGNC symbol)
    */
    String name
    
    /**
    * Is true, if this entry is the main gene name for the protein. Therefore there is only one entry set per protein. <p />
    * While inserting the gene names the shortest symbol and/or first listed is chosen as main gene name of the protein. <p />
    */
    boolean isMainName = false

    
    /**
    * GRAILS <a href="http://grails.org/doc/latest/guide/GORM.html#gormAssociation" target="_blank">Associations in Gorm</a>
    * <p />
    * <style>.custom-table td{border-top:1pt solid grey;vertical-align:top;} .custom-table{border-collapse:collapse;width:100%;}</style>
    * <table class="custom-table">
    * <tr><td>
    *              protein
    * </td><td>        belongs to one specific Protein entry from IPI <p />
    *                  <b>See Also:</b> {@link nci60.data.protein.Protein}
    * </td></tr>
    * </table>
    */
    static belongsTo = [protein:Protein]

    /**
     * GRAILS <a href="http://grails.org/doc/latest/guide/single.html#constraints" target="_blank">Declaring Constraints</a>
     * <p />
     * Constraints in Grails are a way to declaratively specify validation rules for generating objects in GORM.
     */	
    static constraints = {
    }
}
